Loads the contents of the directory from a physical directory, specifying copy buffer size, and a progress update provider.
Syntax
'Declaration
<ExtensionAttribute()>
Public Overloads Shared Function LoadFromOSDirectory( _
ByVal As IWritableDirectoryContents, _
ByVal As String, _
ByVal As Integer, _
ByVal As IProgress(Of String()) _
) As ValueTuple(Of Long,Long,Long)
'Usage
Dim writableDirectoryContents As IWritableDirectoryContents
Dim sourceOSDirectoryPath As String
Dim copyBufferSize As Integer
Dim stringArrayProgress As IProgress(Of String())
Dim value As ValueTuple(Of Long,Long,Long)
value = IWritableDirectoryContentsExtension.LoadFromOSDirectory(writableDirectoryContents, sourceOSDirectoryPath, copyBufferSize, stringArrayProgress)
Parameters
- writableDirectoryContents
- The writable directory contents object that will perform the operation.
The value of this parameter cannot be null (Nothing in Visual Basic).
- sourceOSDirectoryPath
- The path to the physical directory from which this directory should be loaded.
The value of this parameter cannot be null (Nothing in Visual Basic).
- copyBufferSize
- The size of the copy buffer. This value must be greater than zero. The default size is 81920.
Valid values of this parameter are in the range from 1 to 2147483647 (Int32.MaxValue).
- stringArrayProgress
- A provider for progress updates (strings).
The value of this parameter can be null (Nothing in Visual Basic).
Return Value
Returns a tuple with number of bytes copied, number of files copied, and number of directories copied.
Exceptions
| Exception | Description |
|---|
| System.ArgumentNullException |
A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.
This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception. |
| System.ArgumentOutOfRangeException |
The value of an argument is outside the allowable range of values as defined by the invoked method.
This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception. |
| System.IO.DirectoryNotFoundException |
Part of a file or directory cannot be found.
This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately. |
| System.IO.FileNotFoundException |
An attempt to access a file that does not exist on disk has failed.
This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately. |
| System.IO.IOException |
An I/O error has occurred.
This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately. |
| System.NotSupportedException | An invoked method is not supported at all, or is not supported with the parameters used to create the object. |
| System.IO.PathTooLongException |
A path or fully qualified file name is longer than the system-defined maximum length.
This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately. |
| System.Security.SecurityException |
A security error was detected.
This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately. |
| System.UnauthorizedAccessException |
The operating system has denied access because of an I/O error or a specific type of security error.
This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately. |
Requirements
Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows
See Also
